- Cloudmersive Documentation

Node.JS Python C# Java PHP Objective-C Ruby Apex C/C++ cURL Swift JavaScript Go

Run this command to install the SDK:

npm install cloudmersive-convert-api-client --save

Or add this snippet to your package.json:

  "dependencies": {
    "cloudmersive-convert-api-client": "^2.6.3"
  }

var CloudmersiveConvertApiClient = require('cloudmersive-convert-api-client');
var defaultClient = CloudmersiveConvertApiClient.ApiClient.instance;

// Configure API key authorization: Apikey
var Apikey = defaultClient.authentications['Apikey'];
Apikey.apiKey = 'YOUR API KEY';



var apiInstance = new CloudmersiveConvertApiClient.ConvertDocumentApi();

var fileExtension = "fileExtension_example"; // String | Required; The file extension to be used for the icon. Limited to 4 AlphaNumeric characters.

var opts = { 
  'iconSize': 56 // Number | Optional; The desired width of the icon, preserving its aspect ratio.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.convertDocumentGetFileTypeIconAdvanced(fileExtension, opts, callback);

Run this command to install the SDK:

pip install cloudmersive-convert-api-client

from __future__ import print_function
import time
import cloudmersive_convert_api_client
from cloudmersive_convert_api_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: Apikey
configuration = cloudmersive_convert_api_client.Configuration()
configuration.api_key['Apikey'] = 'YOUR_API_KEY'



# create an instance of the API class
api_instance = cloudmersive_convert_api_client.ConvertDocumentApi(cloudmersive_convert_api_client.ApiClient(configuration))
file_extension = 'file_extension_example' # str | Required; The file extension to be used for the icon. Limited to 4 AlphaNumeric characters.
icon_size = 56 # int | Optional; The desired width of the icon, preserving its aspect ratio. (optional)

try:
    # Get PNG icon byte array for the file extension
    api_response = api_instance.convert_document_get_file_type_icon_advanced(file_extension, icon_size=icon_size)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ConvertDocumentApi->convert_document_get_file_type_icon_advanced: %s\n" % e)

.NET Framework | .NET Core

Run this command to install the SDK:

Install-Package Cloudmersive.APIClient.NET.DocumentAndDataConvert -Version 3.4.2

using System;
using System.Diagnostics;
using Cloudmersive.APIClient.NET.DocumentAndDataConvert.Api;
using Cloudmersive.APIClient.NET.DocumentAndDataConvert.Client;
using Cloudmersive.APIClient.NET.DocumentAndDataConvert.Model;

namespace Example
{
    public class ConvertDocumentGetFileTypeIconAdvancedExample
    {
        public void main()
        {
            // Configure API key authorization: Apikey
            Configuration.Default.AddApiKey("Apikey", "YOUR_API_KEY");
            
            

            var apiInstance = new ConvertDocumentApi();
            var fileExtension = fileExtension_example;  // string | Required; The file extension to be used for the icon. Limited to 4 AlphaNumeric characters.
            var iconSize = 56;  // int? | Optional; The desired width of the icon, preserving its aspect ratio. (optional) 

            try
            {
                // Get PNG icon byte array for the file extension
                GetFileTypeIconResult result = apiInstance.ConvertDocumentGetFileTypeIconAdvanced(fileExtension, iconSize);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ConvertDocumentApi.ConvertDocumentGetFileTypeIconAdvanced: " + e.Message );
            }
        }
    }
}

using System;
using System.Diagnostics;
using Cloudmersive.APIClient.NETCore.DocumentAndDataConvert.Api;
using Cloudmersive.APIClient.NETCore.DocumentAndDataConvert.Client;
using Cloudmersive.APIClient.NETCore.DocumentAndDataConvert.Model;

namespace Example
{
    public class ConvertDocumentGetFileTypeIconAdvancedExample
    {
        public void main()
        {
            // Configure API key authorization: Apikey
            Configuration.Default.AddApiKey("Apikey", "YOUR_API_KEY");
            
            

            var apiInstance = new ConvertDocumentApi();
            var fileExtension = fileExtension_example;  // string | Required; The file extension to be used for the icon. Limited to 4 AlphaNumeric characters.
            var iconSize = 56;  // int? | Optional; The desired width of the icon, preserving its aspect ratio. (optional) 

            try
            {
                // Get PNG icon byte array for the file extension
                GetFileTypeIconResult result = apiInstance.ConvertDocumentGetFileTypeIconAdvanced(fileExtension, iconSize);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ConvertDocumentApi.ConvertDocumentGetFileTypeIconAdvanced: " + e.Message );
            }
        }
    }
}

To install with Maven, add a reference to the repository in pom.xml:

<repositories>
    <repository>
        <id>jitpack.io</id>
        <url>https://jitpack.io</url>
    </repository>
</repositories>

And add a reference to the dependency in pom.xml:

<dependencies>
<dependency>
    <groupId>com.github.Cloudmersive</groupId>
    <artifactId>Cloudmersive.APIClient.Java</artifactId>
    <version>v4.25</version>
</dependency>
</dependencies>

To install with Gradle, add it in your root build.gradle at the end of repositories:

allprojects {
	repositories {
		...
		maven { url 'https://jitpack.io' }
	}
}

And add the dependency in build.gradle:

dependencies {
        implementation 'com.github.Cloudmersive:Cloudmersive.APIClient.Java:v4.25'
}

// Import classes:
//import com.cloudmersive.client.invoker.ApiClient;
//import com.cloudmersive.client.invoker.ApiException;
//import com.cloudmersive.client.invoker.Configuration;
//import com.cloudmersive.client.invoker.auth.*;
//import com.cloudmersive.client.ConvertDocumentApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: Apikey
ApiKeyAuth Apikey = (ApiKeyAuth) defaultClient.getAuthentication("Apikey");
Apikey.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Apikey.setApiKeyPrefix("Token");

ConvertDocumentApi apiInstance = new ConvertDocumentApi();
String fileExtension = "fileExtension_example"; // String | Required; The file extension to be used for the icon. Limited to 4 AlphaNumeric characters.
Integer iconSize = 56; // Integer | Optional; The desired width of the icon, preserving its aspect ratio.
try {
    GetFileTypeIconResult result = apiInstance.convertDocumentGetFileTypeIconAdvanced(fileExtension, iconSize);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ConvertDocumentApi#convertDocumentGetFileTypeIconAdvanced");
    e.printStackTrace();
}

Run this command to install the SDK:

composer require cloudmersive/cloudmersive_document_convert_api_client

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: Apikey
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Apikey', 'YOUR_API_KEY');



$apiInstance = new Swagger\Client\Api\ConvertDocumentApi(
    
    
    new GuzzleHttp\Client(),
    $config
);
$file_extension = "file_extension_example"; // string | Required; The file extension to be used for the icon. Limited to 4 AlphaNumeric characters.
$icon_size = 56; // int | Optional; The desired width of the icon, preserving its aspect ratio.

try {
    $result = $apiInstance->convertDocumentGetFileTypeIconAdvanced($file_extension, $icon_size);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ConvertDocumentApi->convertDocumentGetFileTypeIconAdvanced: ', $e->getMessage(), PHP_EOL;
}
?>

Add the Objective-C client to your Podfile:

pod 'CloudmersiveDocumentAndDataConvertApiClient', '~> 1.0'

CMDefaultConfiguration *apiConfig = [CMDefaultConfiguration sharedConfig];

// Configure API key authorization: (authentication scheme: Apikey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Apikey"];




NSString* fileExtension = @"fileExtension_example"; // Required; The file extension to be used for the icon. Limited to 4 AlphaNumeric characters.
NSNumber* iconSize = @56; // Optional; The desired width of the icon, preserving its aspect ratio. (optional)

CMConvertDocumentApi*apiInstance = [[CMConvertDocumentApi alloc] init];

// Get PNG icon byte array for the file extension
[apiInstance convertDocumentGetFileTypeIconAdvancedWithFileExtension:fileExtension
              iconSize:iconSize
          completionHandler: ^(CMGetFileTypeIconResult* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling CMConvertDocumentApi->convertDocumentGetFileTypeIconAdvanced: %@", error);
                        }
                    }];

Add the Ruby client to your Gemfile:

gem 'cloudmersive-convert-api-client', '~> 2.1.6'

# load the gem
require 'cloudmersive-convert-api-client'
# setup authorization
CloudmersiveConvertApiClient.configure do |config|
  # Configure API key authorization: Apikey
  config.api_key['Apikey'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['Apikey'] = 'Bearer'
end

api_instance = CloudmersiveConvertApiClient::ConvertDocumentApi.new

file_extension = 'file_extension_example' # String | Required; The file extension to be used for the icon. Limited to 4 AlphaNumeric characters.

opts = { 
  icon_size: 56 # Integer | Optional; The desired width of the icon, preserving its aspect ratio.
}

begin
  #Get PNG icon byte array for the file extension
  result = api_instance.convert_document_get_file_type_icon_advanced(file_extension, opts)
  p result
rescue CloudmersiveConvertApiClient::ApiError => e
  puts "Exception when calling ConvertDocumentApi->convert_document_get_file_type_icon_advanced: #{e}"
end

Download and copy the /client folder into your Apex project:

Download Apex Client

SwagConvertDocumentApi api = new SwagConvertDocumentApi();
SwagClient client = api.getClient();

// Configure API key authorization: Apikey
ApiKeyAuth Apikey = (ApiKeyAuth) client.getAuthentication('Apikey');
Apikey.setApiKey('YOUR API KEY');

Map<String, Object> params = new Map<String, Object>{
    'fileExtension' => 'fileExtension_example',
    'iconSize' => 56
};

try {
    // cross your fingers
    SwagGetFileTypeIconResult result = api.convertDocumentGetFileTypeIconAdvanced(params);
    System.debug(result);
} catch (Swagger.ApiException e) {
    // ...handle your exceptions
}

Install libcurl in your C/C++ project:

libcurl/7.75.0

CURL *curl;
CURLcode res;
curl = curl_easy_init();
if(curl) {
     curl_easy_setopt(curl, CURLOPT_CUSTOMREQUEST, "POST");
     curl_easy_setopt(curl, CURLOPT_URL, "https://api.cloudmersive.com/convert/autodetect/get-icon/advanced");
     curl_easy_setopt(curl, CURLOPT_FOLLOWLOCATION, 1L);
     curl_easy_setopt(curl, CURLOPT_DEFAULT_PROTOCOL, "https");
     struct curl_slist *headers = NULL;
     headers = curl_slist_append(headers, "fileExtension: <string>");
     headers = curl_slist_append(headers, "iconSize: <integer>");
     headers = curl_slist_append(headers, "Apikey: YOUR-API-KEY-HERE");
     curl_easy_setopt(curl, CURLOPT_HTTPHEADER, headers);
     res = curl_easy_perform(curl);
}
curl_easy_cleanup(curl);

curl --location --request POST 'https://api.cloudmersive.com/convert/autodetect/get-icon/advanced' \
--header 'fileExtension: <string>' \
--header 'iconSize: <integer>' \
--header 'Apikey: YOUR-API-KEY-HERE'

import Foundation
#if canImport(FoundationNetworking)
import FoundationNetworking
#endif

var semaphore = DispatchSemaphore (value: 0)

var request = URLRequest(url: URL(string: "https://api.cloudmersive.com/convert/autodetect/get-icon/advanced")!,timeoutInterval: Double.infinity)
request.addValue("<string>", forHTTPHeaderField: "fileExtension")
request.addValue("<integer>", forHTTPHeaderField: "iconSize")
request.addValue("YOUR-API-KEY-HERE", forHTTPHeaderField: "Apikey")

request.httpMethod = "POST"

let task = URLSession.shared.dataTask(with: request) { data, response, error in 
     guard let data = data else {
          print(String(describing: error))
          semaphore.signal()
          return
     }
     print(String(data: data, encoding: .utf8)!)
     semaphore.signal()
}

task.resume()
semaphore.wait()

XHR | jQuery

This code snippet uses the built-in JavaScript XHR request capability


var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function() {
     if(this.readyState === 4) {
          console.log(this.responseText);
     }
});

xhr.open("POST", "https://api.cloudmersive.com/convert/autodetect/get-icon/advanced");
xhr.setRequestHeader("fileExtension", "<string>");
xhr.setRequestHeader("iconSize", "<integer>");
xhr.setRequestHeader("Apikey", "YOUR-API-KEY-HERE");

xhr.send();

var settings = {
     "url": "https://api.cloudmersive.com/convert/autodetect/get-icon/advanced",
     "method": "POST",
     "timeout": 0,
     "headers": {
          "fileExtension": "<string>",
          "iconSize": "<integer>",
          "Apikey": "YOUR-API-KEY-HERE"
     },
};

$.ajax(settings).done(function (response) {
     console.log(response);
});

package main

import (
     "fmt"
     "net/http"
     "io/ioutil"
)

func main() {

     url := "https://api.cloudmersive.com/convert/autodetect/get-icon/advanced"
     method := "POST"

     client := &http.Client {
     }
     req, err := http.NewRequest(method, url, nil)

     if err != nil {
          fmt.Println(err)
          return
     }
     req.Header.Add("fileExtension", "<string>")
     req.Header.Add("iconSize", "<integer>")
     req.Header.Add("Apikey", "YOUR-API-KEY-HERE")

     res, err := client.Do(req)
     if err != nil {
          fmt.Println(err)
          return
     }
     defer res.Body.Close()

     body, err := ioutil.ReadAll(res.Body)
     if err != nil {
          fmt.Println(err)
          return
     }
     fmt.Println(string(body))
}

Walkthrough Video